<!DOCTYPE html>
  
  
  
  
   <html class="no-js"> 

  <head lang="en-us">
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
    <meta http-equiv="X-UA-Compatible" content="IE=10" />
    <title>Getting Started - Laradock</title>
    <meta name="generator" content="Hugo 0.18.1" />

    
    <meta name="description" content="Laradock documentations.">
    
    <link rel="canonical" href="http://laradock.io/getting-started/">
    
    <meta name="author" content="Mahmoud Zalt">
    

    <meta property="og:url" content="http://laradock.io/getting-started/">
    <meta property="og:title" content="Laradock">
    
    <meta name="apple-mobile-web-app-title" content="Laradock">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">

    <link rel="shortcut icon" type="image/x-icon" href="http://laradock.io/images/favicon.ico">
    <link rel="icon" type="image/x-icon" href="http://laradock.io/images/favicon.ico">

    <style>
      @font-face {
        font-family: 'Icon';
        src: url('http://laradock.io/fonts/icon.eot');
        src: url('http://laradock.io/fonts/icon.eot')
               format('embedded-opentype'),
             url('http://laradock.io/fonts/icon.woff')
               format('woff'),
             url('http://laradock.io/fonts/icon.ttf')
               format('truetype'),
             url('http://laradock.io/fonts/icon.svg')
               format('svg');
        font-weight: normal;
        font-style: normal;
      }
    </style>

    <link rel="stylesheet" href="http://laradock.io/stylesheets/application.css">
    <link rel="stylesheet" href="http://laradock.io/stylesheets/temporary.css">
    <link rel="stylesheet" href="http://laradock.io/stylesheets/palettes.css">
    <link rel="stylesheet" href="http://laradock.io/stylesheets/highlight/highlight.css">

    
    
    
    <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Doctarine:400,700|Source&#43;Code&#43;Pro">
    <style>
      body, input {
        font-family: 'Doctarine', Helvetica, Arial, sans-serif;
      }
      pre, code {
        font-family: 'Source Code Pro', 'Courier New', 'Courier', monospace;
      }
    </style>

    
    <script src="http://laradock.io/javascripts/modernizr.js"></script>

    

  </head>
  <body class="palette-primary-deep-purple palette-accent-purple">




<div class="backdrop">
	<div class="backdrop-paper"></div>
</div>

<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>

<header class="header">
	<nav aria-label="Header">
  <div class="bar default">
    <div class="button button-menu" role="button" aria-label="Menu">
      <label class="toggle-button icon icon-menu" for="toggle-drawer">
        <span></span>
      </label>
    </div>
    <div class="stretch">
      <div class="title">
          <b>Laradock</b> <span style="color: rgba(249, 245, 255, 0.63);"> / Getting Started</span>
      </div>
    </div>

    

    
    <div class="button button-github" role="button" aria-label="GitHub">
        <a style="padding: 0px; font-size:40px" href="https://github.com/laradock/laradock" title="@laradock/laradock on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
    </div>
      <p style="font-size: 18px; padding: 8px">Github</p>
    
    
        
  </div>
  <div class="bar search">
    <div class="button button-close" role="button" aria-label="Close">
      <label class="toggle-button icon icon-back" for="toggle-search"></label>
    </div>
    <div class="stretch">
      <div class="field">
        <input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
      </div>
    </div>
    <div class="button button-reset" role="button" aria-label="Search">
      <button class="toggle-button icon icon-close" id="reset-search"></button>
    </div>
  </div>
</nav>

</header>

<main class="main">
	<div class="drawer">
		<nav aria-label="Navigation">
  
    
      
      
        
        
      
    
  

  <div class="scrollable">
    <div class="wrapper">
      

      <div class="toc">
        
        <ul>
          




<li>
  
    



<a  title="Introduction" href="http://laradock.io/introduction/">
	
	Introduction
</a>



  
</li>



<li>
  
    



<a class="current" title="Getting Started" href="http://laradock.io/getting-started/">
	
	Getting Started
</a>


<ul id="scrollspy">
</ul>


  
</li>



<li>
  
    



<a  title="Documentation" href="http://laradock.io/documentation/">
	
	Documentation
</a>



  
</li>



<li>
  
    



<a  title="Related Projects" href="http://laradock.io/related-projects/">
	
	Related Projects
</a>



  
</li>



<li>
  
    



<a  title="Help &amp; Questions" href="http://laradock.io/help/">
	
	Help &amp; Questions
</a>



  
</li>



<li>
  
    



<a  title="Contributing" href="http://laradock.io/contributing/">
	
	Contributing
</a>



  
</li>



<li>
  
    



<a  title="License" href="http://laradock.io/license/">
	
	License
</a>



  
</li>


        </ul>
        

        
        
        
        
        <ul>
          

          
          
            
              
            
          
          

          
        </ul>
        
      </div>
    </div>
  </div>
</nav>

	</div>

	<article class="article">
		<div class="wrapper">
			<h1>Getting Started </h1>

			

<h2 id="requirements">Requirements</h2>

<ul>
<li><a href="https://git-scm.com/downloads">Git</a></li>
<li><a href="https://www.docker.com/products/docker/">Docker</a> <code>&gt;= 1.12</code></li>
</ul>

<h2 id="installation">Installation</h2>

<p>Choose the setup the best suits your needs.</p>

<ul>
<li><a href="#A">A) Setup for Single Project</a>

<ul>
<li><a href="#A1">A.1) Already have a PHP project</a></li>
<li><a href="#A2">A.2) Don&rsquo;t have a PHP project yet</a></li>
</ul></li>
<li><a href="#B">B) Setup for Multiple Projects</a></li>
</ul>

<p><a name="A"></a></p>

<h3 id="a-setup-for-single-project">A) Setup for Single Project</h3>

<blockquote>
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
</blockquote>

<p><a name="A1"></a></p>

<h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>

<p>1 - Clone laradock on your project root directory:</p>

<pre><code class="language-bash">git submodule add https://github.com/Laradock/laradock.git
</code></pre>

<p><strong>Notes:</strong></p>

<ul>
<li><p>If you are not using Git yet for your project, you can use <code>git clone</code> instead of <code>git submodule</code>.</p></li>

<li><p>Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. <a href="#keep-tracking-Laradock">Check this</a></p></li>
</ul>

<p>Your folder structure should look like this:</p>

<pre><code>+ project-a
	+ laradock-a
+ project-b
	+ laradock-b
</code></pre>

<p>(It&rsquo;s important to rename the folders differently in each project.)</p>

<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>

<p><a name="A2"></a></p>

<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>

<p>1 - Clone this repository anywhere on your machine:</p>

<pre><code class="language-bash">git clone https://github.com/laradock/laradock.git
</code></pre>

<p>Your folder structure should look like this:</p>

<pre><code>+ laradock
+ project-z
</code></pre>

<p>2 - Edit your web server sites configuration.</p>

<p><strong>In case of NGINX:</strong> open <code>nginx/sites/default.conf</code> and change the <code>root</code> from <code>/var/www/public</code> to <code>/var/www/{my-project-folder-name}/public</code>.</p>

<p><em>Or you can keep <code>default.conf</code> as it is, and create a separate config <code>my-site.conf</code> file for it.</em></p>

<p><strong>In case of Apache:</strong> :P
<br></p>

<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>

<p><a name="B"></a></p>

<h3 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h3>

<blockquote>
<p>(Follow these steps if you want a single Docker environment for all your project)</p>
</blockquote>

<p>1 - Clone this repository anywhere on your machine (similar to <a href="#A2">Steps A.2. from above</a>):</p>

<pre><code class="language-bash">git clone https://github.com/laradock/laradock.git
</code></pre>

<p>Your folder structure should look like this:</p>

<pre><code>+ laradock
+ project-1
+ project-2
</code></pre>

<p>2 - Go to <code>nginx/sites</code> and create config files to point to different project directory when visiting different domains.</p>

<p>Laradock by default includes <code>project-1.conf</code> and <code>project-2.conf</code> as working samples.</p>

<p>3 - change the default names <code>project-n</code>:</p>

<p>You can rename the config files, project folders and domains as you like, just make sure the <code>root</code> in the config files, is pointing to the correct project folder name.</p>

<p>4 - Add the domains to the <strong>hosts</strong> files.</p>

<pre><code>127.0.0.1  project-1.dev
127.0.0.1  project-2.dev
</code></pre>

<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>

<p><a name="Usage"></a></p>

<h2 id="usage">Usage</h2>

<p><strong>Read Before starting:</strong></p>

<p>If you are using <strong>Docker Toolbox</strong> (VM), do one of the following:</p>

<ul>
<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="#upgrading-laradock">Upgrading Laradock</a></li>
<li>Use Laradock v3.* (Visit the <code>Laradock-ToolBox</code> <a href="https://github.com/laradock/laradock/tree/Laradock-ToolBox">Branch</a>).</li>
</ul>

<p><br></p>

<blockquote>
<p><strong>Warning:</strong> If you used an older version of Laradock it&rsquo;s highly recommended to rebuild the containers you need to use <a href="#Build-Re-build-Containers">see how you rebuild a container</a> in order to prevent as much errors as possible.</p>
</blockquote>

<p><br></p>

<p>1 - Enter the laradock folder and rename <code>env-example</code> to <code>.env</code></p>

<pre><code class="language-shell">cp env-example .env
</code></pre>

<p>You can edit the <code>.env</code> file to chose which software&rsquo;s you want to be installed in your environment. You can always refer to the <code>docker-compose.yml</code> file to see how those variables are been used.</p>

<p>2 - Build the enviroment and run it using <code>docker-compose</code></p>

<p>In this example we&rsquo;ll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:</p>

<pre><code class="language-bash">docker-compose up -d nginx mysql
</code></pre>

<p><strong>Note</strong>: The <code>workspace</code> and <code>php-fpm</code> will run automatically in most of the cases, so no need to specify them in the <code>up</code> command. If you couldn&rsquo;t find them running then you need specify them as follow: <code>docker-compose up -d nginx php-fpm mysql workspace</code>.</p>

<p>You can select your own combination of containers form the list below:</p>

<blockquote>
<p><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>beanstalkd-console</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>, <code>postgres-postgis</code>, <code>certbot</code>, <code>mailhog</code>, <code>minio</code> and more&hellip;!</p>
</blockquote>

<p><em>(Please note that sometimes we forget to update the docs, so check the <code>docker-compose.yml</code> file to see an updated list of all available containers).</em></p>

<p><br>
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &hellip;)</p>

<pre><code class="language-bash">docker-compose exec workspace bash
</code></pre>

<p><em>Alternatively, for Windows PowerShell users: execute the following command to enter any running container:</em></p>

<pre><code class="language-bash">docker exec -it {workspace-container-id} bash
</code></pre>

<p><strong>Note:</strong> You can add <code>--user=laradock</code> to have files created as your host&rsquo;s user. Example:</p>

<pre><code class="language-shell">docker-compose exec --user=laradock workspace bash
</code></pre>

<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>.env</code> file)</em></p>

<p><br>
4 - Update your project configurations to use the database host</p>

<p>Open your PHP project&rsquo;s <code>.env</code> file or whichever configuration file you are reading from, and set the database host <code>DB_HOST</code> to <code>mysql</code>:</p>

<pre><code class="language-env">DB_HOST=mysql
</code></pre>

<p><em>If you want to install Laravel as PHP project, see <a href="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></p>

<p><br>
5 - Open your browser and visit your localhost address <code>http://localhost/</code>. If you followed the multiple projects setup, you can visit <code>http://project-1.dev/</code> and <code>http://project-2.dev/</code>. But first don&rsquo;t</p>


			<aside class="copyright" role="note">
				
				Documentation built with
				<a href="https://www.gohugo.io" target="_blank">Hugo</a>
				using the
				<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
			</aside>

			<footer class="footer">
				

<nav class="pagination" aria-label="Footer">
  <div class="previous">
  
      <a href="http://laradock.io/introduction/" title="Introduction">
        <span class="direction">
          Previous
        </span>
        <div class="page">
          <div class="button button-previous" role="button" aria-label="Previous">
            <i class="icon icon-back"></i>
          </div>
          <div class="stretch">
            <div class="title">
              Introduction
            </div>
          </div>
        </div>
      </a>
  
  </div>

  <div class="next">
  
      <a href="http://laradock.io/documentation/" title="Documentation">
        <span class="direction">
          Next
        </span>
        <div class="page">
          <div class="stretch">
            <div class="title">
              Documentation
            </div>
          </div>
          <div class="button button-next" role="button" aria-label="Next">
            <i class="icon icon-forward"></i>
          </div>
        </div>
      </a>
  
  </div>
</nav>





			</footer>
		</div>
	</article>

	<div class="results" role="status" aria-live="polite">
		<div class="scrollable">
			<div class="wrapper">
				<div class="meta"></div>
				<div class="list"></div>
			</div>
		</div>
	</div>
</main>

    <script>
    
      var base_url = '';
      var repo_id  = '';
    
    </script>

    <script src="http://laradock.io/javascripts/application.js"></script>
    

    <script>
      /* Add headers to scrollspy */
      var headers   = document.getElementsByTagName("h2");
      var scrollspy = document.getElementById('scrollspy');

      if(scrollspy) {
        if(headers.length > 0) {
          for(var i = 0; i < headers.length; i++) {
            var li = document.createElement("li");
            li.setAttribute("class", "anchor");

            var a  = document.createElement("a");
            a.setAttribute("href", "#" + headers[i].id);
            a.setAttribute("title", headers[i].innerHTML);
            a.innerHTML = headers[i].innerHTML;

            li.appendChild(a)
            scrollspy.appendChild(li);
          }
        } else {
          scrollspy.parentElement.removeChild(scrollspy)
        }


        /* Add permanent link next to the headers */
        var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");

        for(var i = 0; i < headers.length; i++) {
            var a = document.createElement("a");
            a.setAttribute("class", "headerlink");
            a.setAttribute("href", "#" + headers[i].id);
            a.setAttribute("title", "Permanent link")
            a.innerHTML = "#";
            headers[i].appendChild(a);
        }
      }
    </script>

    
      <script>
        (function(i,s,o,g,r,a,m){
          i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||
          []).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;
          m.parentNode.insertBefore(a,m)
        })(window, document,
          'script', '//www.google-analytics.com/analytics.js', 'ga');
         
        ga('create', 'UA-37514928-9', 'auto');
        ga('set', 'anonymizeIp', true);
        ga('send', 'pageview');
         
        var buttons = document.querySelectorAll('a');
        Array.prototype.map.call(buttons, function(item) {
          if (item.host != document.location.host) {
            item.addEventListener('click', function() {
              var action = item.getAttribute('data-action') || 'follow';
              ga('send', 'event', 'outbound', action, item.href);
            });
          }
        });
         
        var query = document.querySelector('.query');
        query.addEventListener('blur', function() {
          if (this.value) {
            var path = document.location.pathname;
            ga('send', 'pageview', path + '?q=' + this.value);
          }
        });
      </script>
    

    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
    <script>hljs.initHighlightingOnLoad();</script>
  </body>
</html>

